/* (c)2010-2013 Andrea Caltroni (andrea.caltroni@pd.infn.it), INFN (www.infn.it)
 *
 * This file is part of the IGI Survey Portlet (from here on shortened to IGISP).
 * IGISP is free software: you can redistribute it and/or modify it 
 * under the terms of the GNU General Public License as published by the Free 
 * Software Foundation, either version 3 of the License, or (at your option) any 
 * later version.
 *
 * IGISP is distributed in the hope that it will be useful, but WITHOUT ANY 
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with IGISP. If not, see <http://www.gnu.org/licenses/>.
 */
package it.infn.grid.liferay.survey.modules.admin.controller;

import it.infn.grid.liferay.survey.modules.admin.web.AnswerModePropertyEditor;
import it.infn.grid.liferay.survey.modules.admin.web.AnswerValidator;
import it.infn.grid.liferay.survey.modules.admin.web.QuestionPropertyEditor;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import javax.portlet.ActionRequest;
import javax.portlet.ActionResponse;

import org.ajm.spring.survey.modules.admin.model.Answer;
import org.ajm.spring.survey.modules.admin.model.AnswerMode;
import org.ajm.spring.survey.modules.admin.model.AnswersType;
import org.ajm.spring.survey.modules.admin.model.Question;
import org.ajm.spring.survey.modules.admin.service.AnswerService;
import org.ajm.spring.survey.modules.admin.service.QuestionService;
import org.apache.log4j.Logger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.validation.BindingResult;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.support.SessionStatus;
import org.springframework.web.portlet.bind.PortletRequestDataBinder;
import org.springframework.web.portlet.bind.annotation.ActionMapping;
import org.springframework.web.portlet.bind.annotation.RenderMapping;

/**
 * The controller for all actions concerning the addition of a new Answer.
 * 
 * @author Andrea Caltroni, andrea.caltroni@pd.infn.it, INFN
 */
@RequestMapping(value="VIEW")
@Controller(value="addAnswerController")
public class AddAnswerController {

    // --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --|
    // --- [  CONSTANTS  ] ----------------------------------------------------|
    // --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --|
    
    // --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --|
    // --- [  CLASS VARIABLES  ]-----------------------------------------------|
    // --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --|
    
    static Logger logger = Logger.getLogger(AddAnswerController.class);
    
    // --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --|
    // --- [  INSTANCE VARIABLES  ]--------------------------------------------|
    // --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --|

    @Autowired
    @Qualifier("answerService")
    private AnswerService answerService;
    
    @Autowired
    @Qualifier("questionService")
    private QuestionService questionService;
    
    @Autowired
    @Qualifier("answerValidator")
    private AnswerValidator answerValidator;
    
    // --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --|
    // --- [  CONSTRUCTORS  ]--------------------------------------------------|
    // --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --|

    // --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --|
    // --- [  CLASS METHODS  ]-------------------------------------------------|
    // --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --|

    // --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --|
    // --- [  INSTANCE METHODS  ]----------------------------------------------|
    // --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --|

    /**
     * Setup binder for adding/editing answers.
     */
    @InitBinder
    protected void initBinder(PortletRequestDataBinder binder) {
        
        binder.registerCustomEditor(AnswerMode.class, new AnswerModePropertyEditor());
        binder.registerCustomEditor(Question.class, new QuestionPropertyEditor(questionService));
    }

    // ------------------------------------------------------------------------|

    @ModelAttribute("answer")
    public Answer getCommandObject(@RequestParam("questionID") Long questionId) {
        
        Question question = getQuestionService().findById(questionId);
        Answer newAnswer = new Answer();
        newAnswer.setQuestion(question);
        // default value
        if (question.getAnswersType().compareTo(AnswersType.SINGLE_ANSWER) == 0) {
            newAnswer.setAnswerMode(AnswerMode.CUSTOM_DESC);
        }
        else {
            newAnswer.setAnswerMode(AnswerMode.SELECTION);
        }
        
        return newAnswer;
    }

    // ------------------------------------------------------------------------|
    
    /**
     * Adds an answer (Add, render phase.)
     * 
     * @param questionId 
     * @param model 
     * @return The attribute in the model defining the action of editing an answer.
     */
    @RenderMapping(params="action=showAddAnswerForm")
    public String showAddAnswerForm(@RequestParam("questionID") Long questionId, Model model) {
        
    	Question question = getQuestionService().findById(questionId);
    	
        model.addAttribute("question", question);
        model.addAttribute("answerPositions", getQuestionService().findValidAnswerPositions(question, null));
        
        if (!getQuestionService().hasUserDescAnswer(question)) {
            if (question.getAnswersType().compareTo(AnswersType.SINGLE_ANSWER) == 0) {
                // the only valid mode is CUSTOM_DESC for SINGLE_ANSWER questions
                List<AnswerMode> purgedModes = new ArrayList<AnswerMode> ();
                purgedModes.add(AnswerMode.CUSTOM_DESC);
                model.addAttribute("answerModeValues", purgedModes);
            }
            else {
                model.addAttribute("answerModeValues", Arrays.asList(AnswerMode.values()));
            }
        }
        else {
            // avoids multiple CUSTOM_DESC answers for the same question
            List<AnswerMode> purgedModes = new ArrayList<AnswerMode> ();
            for (AnswerMode mode: AnswerMode.values()) {
                if (mode.compareTo(AnswerMode.CUSTOM_DESC) != 0) {
                    purgedModes.add(mode);
                }
            }
            model.addAttribute("answerModeValues", purgedModes);
        }
        
        return "answerAdd";
    }

    // ------------------------------------------------------------------------|

    /**
     * Saves a new answer after validating it (Add, action phase.)
     * 
     * @param request 
     * @param response 
     * @param answer 
     * @param result 
     * @param sessionStatus 
     */
    @ActionMapping(params="action=addAnswer")
    public void submitEditAnswerForm(ActionRequest request, ActionResponse response,
            @ModelAttribute("answer") Answer answer, BindingResult result, SessionStatus sessionStatus) {

        getAnswerValidator().validate(answer, result);
        
        if (!result.hasErrors()) {
            Answer savedAnswer = getAnswerService().save(answer);
            response.setRenderParameter("action", "viewQuestionAnswers");
            response.setRenderParameter("questionID", savedAnswer.getQuestion().getId().toString());
        }
        else {
            if (logger.isDebugEnabled()) {
                for (ObjectError error: result.getAllErrors()) {
                    logger.debug("Answer add form reported [" + error.toString() + "]");
                }
            }
            
            response.setRenderParameter("action", "showAddAnswerForm");
            response.setRenderParameter("question", answer.getQuestion().getId().toString());
        }
    }

    // --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --|
    // ---[  GETTERS AND SETTERS  ]--------------------------------------------|
    // --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --|

    /**
     * @return the answerValidator
     */
    public AnswerValidator getAnswerValidator() {
        
        return answerValidator;
    }

    // ------------------------------------------------------------------------|

    /**
     * @param answerValidator the answerValidator to set
     */
    public void setAnswerValidator(AnswerValidator answerValidator) {
        
        this.answerValidator = answerValidator;
    }

    // ------------------------------------------------------------------------|

    /**
     * @return the answerService
     */
    public AnswerService getAnswerService() {
        
        return answerService;
    }

    // ------------------------------------------------------------------------|

    /**
     * @param answerService the answerService to set
     */
    public void setAnswerService(AnswerService answerService) {
        
        this.answerService = answerService;
    }

    // ------------------------------------------------------------------------|

    /**
     * @return the questionService
     */
    public QuestionService getQuestionService() {
        
        return questionService;
    }

    // ------------------------------------------------------------------------|

    /**
     * @param questionService the questionService to set
     */
    public void setQuestionService(QuestionService questionService) {
        
        this.questionService = questionService;
    }

    // ------------------------------------------------------------------------|

}
